/**
 * Copyright 2009 Dan Hansen <hansen.danr@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.googlecode.php.mojo.archiver;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;

import org.codehaus.plexus.archiver.ArchiverException;
import org.codehaus.plexus.archiver.jar.JarArchiver;
import org.codehaus.plexus.archiver.zip.AbstractZipArchiver;

/**
 * Base class for tasks that build archives in PHAR file format.
 * 
 * @author dhansen
 */
public class PharArchiver
	extends JarArchiver
{

	private static final String STUB_DESTINATION = ".phar/stub.php";
	private static final String STUB_MINIMAL = "minimal-stub.php";
	private File stub;

	/**
	 * Default constructor.
	 * 
	 * @param stubIn
	 */
	public PharArchiver( final File stubIn )
	{
		super();

		archiveType = "phar";
		stub = stubIn;
	}

	/*
	 * (non-Javadoc)
	 * @see org.codehaus.plexus.archiver.zip.AbstractZipArchiver#execute()
	 */
	/**
	 * @throws ArchiverException,IOException
	 */
	@Override
	public void execute() throws ArchiverException, IOException
	{
		addFile( stub, STUB_DESTINATION );

		super.execute();
	}

	/**
	 * @param stubIn The new stub file.
	 */
	public void setStub( final File stubIn )
	{
		stub = stubIn;
	}

	/**
	 * @return InputStream
	 */
	public static InputStream getDefaultStub()
	{
		return Thread.currentThread().getContextClassLoader().getResourceAsStream( STUB_MINIMAL );
	}

	/**
	 * @see AbstractZipArchiver
	 */
	public void cleanup()
	{
		stub = null;
		super.cleanUp();
	}
}
